package com.example.apidocserver.domain.document.service;

import com.example.apidocserver.domain.document.entity.ApiInfo;
import com.example.apidocserver.infrastructure.aop.UpsertAnno;

import java.util.List;

/**
 * 接口信息表(ApiInfo)表服务接口
 *
 * @author makejava
 * @since 2023-02-22 23:03:28
 */
public interface ApiInfoService {

    /**
     * 通过ID查询单条数据
     *
     * @param id 主键
     * @return 实例对象
     */
    ApiInfo queryById(Integer id);

    /**
     * 查询所有对象
     *
     * @return 查询结果
     */
    List<ApiInfo> queryAll();

    /**
     * 根据对象查询
     *
     * @param apiInfo 筛选条件
     * @return 查询结果
     */
    List<ApiInfo> queryByEntity(ApiInfo apiInfo);

    /**
     * 新增数据
     *
     * @param apiInfo 实例对象
     * @return 实例对象
     */
    ApiInfo insert(ApiInfo apiInfo);

    /**
     * 修改数据
     *
     * @param apiInfo 实例对象
     * @return 实例对象
     */
    ApiInfo update(ApiInfo apiInfo);

    /**
     * 通过主键删除数据
     *
     * @param id 主键
     * @return 是否成功
     */
    boolean deleteById(Integer id);

    /**
     * 获取文档默认接口
     *
     * @param docId 文档id
     * @return 接口信息
     */
    ApiInfo getDefApiInfo(Integer docId);

    /**
     * 根据接口名称或者接口路由查询接口信息
     *
     * @param apiInfo 查询信息
     * @param docId   文档id
     * @return 接口信息集合
     */
    List<ApiInfo> findApiLike(ApiInfo apiInfo, Integer docId);

    /**
     * 查询工作空间下所有接口信息
     *
     * @param spaceId 接口id
     * @return 接口信息集合
     */
    List<ApiInfo> findAllBySpaceId(Integer spaceId);

    /**
     * 批量插入或查询
     *
     * @param apiInfoList 接口信息
     */
    void insertOrFindBatch(List<ApiInfo> apiInfoList);
}
